<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 transitional//EN">
<html>
<head>
<title>Sort Key Element (Eclipse BIRT ROM Documentation)</title>
<link rel="stylesheet" href="../style/style.css" type="text/css"/>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
</head>
<body>
<p class="title">Eclipse BIRT Report Object Model (ROM)</p>
<p class="subtitle">SortKey Structure</p>
<h1>Structure Overview</h1>
<div class="section-text">
A sort definition consisting of an expression and sort 
direction.</div>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Display Name:</td>
<td>Sort Key</td></tr>
<tr><td>Since:</td>
<td>1.0</td></tr>
</table>

<h3>Property Summary</h3>

<dl class="section-text">
<dt><a href="#Property-direction">direction</a></dt>
<dd>The sort direction: Ascending (the default) or Descending.</dd>
<dt><a href="#Property-key">key</a></dt>
<dd>An expression that gives the sort key on which to 
sort.</dd>
<dt><a href="#Property-locale">locale</a></dt>
<dd></dd>
<dt><a href="#Property-strength">strength</a></dt>
<dd></dd>
</dl>

<h3>Description</h3>

<div class="section-text">
<p>Report sorting and group sorting is defined as a series 
of column, sort direction pairs. Each pair is a Sort Criteria structure.</p></div>
<h1>Property Detail</h1>

<h2><a name="Property-direction">direction Property</a></h2>

<p class="section-text">The sort direction: Ascending (the default) or Descending.</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../types.html#choice">choice</a> (sortDirection)</td></tr>
<tr><td>Since:</td>
<td>1.0</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Sort Direction</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>asc</td></tr>
<tr><td>Runtime Settable:</td>
<td>No</td></tr>
</table>

<h3>Choices</h3>

<table class="section-table">
<thead><tr><td>Name</td><td>Display Name</td>
<td>Value</td><td>Description</td></tr></thead>
<tbody>
<tr><td>asc</td>
<td>Ascending</td>
<td>asc</td>
<td>Sort values from lowest 
    to highest.</td></tr>
<tr><td>desc</td>
<td>Descending</td>
<td>desc</td>
<td>Sort values from 
    highest to lowest.</td></tr>
</tbody></table><br>
<h3>Description</h3>

<div class="section-text">
<p>The sort direction: Ascending (the default) or 
Descending.</p></div>

<hr>
<h2><a name="Property-key">key Property</a></h2>

<p class="section-text">An expression that gives the sort key on which to 
sort.</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../types.html#expression">expression</a></td></tr>
<tr><td>Context:</td>
<td></td></tr>
<tr><td>Expression Type:</td>
<td>any</td></tr>
<tr><td>Since:</td>
<td>1.0</td></tr>
<tr><td>Required:</td>
<td>Yes</td></tr>
<tr><td>Display Name:</td>
<td>Sort Key</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>None</td></tr>
<tr><td>Runtime Settable:</td>
<td>No</td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p>An expression that gives the sort key on which to sort. 
The simplest case is the name of a column. The expression can also be an 
expression that includes columns. When used for a group, the expression can 
contain an aggregate computed over the group.</p>

<p>Expressions that include only a column name are 
candidates for &quot;pushing&quot; into the data set. However, sort keys that are 
expressions must be evaluated within BIRT, and so the sorting itself must occur 
within BIRT.</p></div>

<hr>
<h2><a name="Property-locale">locale Property</a></h2>

<p class="section-text"></p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../types.html#locale">locale</a></td></tr>
<tr><td>Since:</td>
<td>2.5</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Sort Locale</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>None</td></tr>
<tr><td>Runtime Settable:</td>
<td>No</td></tr>
</table>


<hr>
<h2><a name="Property-strength">strength Property</a></h2>

<p class="section-text"></p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../types.html#integer">integer</a></td></tr>
<tr><td>Since:</td>
<td>2.5</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Sort Strength</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>-1</td></tr>
<tr><td>Runtime Settable:</td>
<td>No</td></tr>
</table>

</body>
</html>
